Skip to main content

Project tech description

To use reusable comoments we use MUI to build our application so we were able to use those elements on different pages with ease and accelerate our work.

To switch between pages we used components from react-router-dom package that contains bindings for using React Router.

To create a database for storing, managing and providing information we used PHPMyAdmin.

Project Setup#

To run the project locally follow these steps:

  1. Clone this repository
  2. Open repository in your code editor
  3. Run command yarn install - without this you will not be able to run the app!
  4. Run command yarn build:watch to run TypeScript build task in watch mode.
  5. Run command docker-compose up -d to start all required Docker containers

Notes (for Windows users):#

  • If you are a Windows user, please use Git Bash or any other UNIX-like shell (e.g. Git Bash). Some commands MAY NOT work on default Windows Command Line.
  • In addition, you may come across linebreak-style error because Windows enforces the usage of Windows line endings: \r\n - if it happens, use yarn format command and then error should not occur.

Tech requirements#

To run this project you have to:

  • Clone this repository
  • Run yarn install in root directory
  • Run yarn build:watch to run TypeScript build task in watch mode
  • Run docker-compose up -d-starts all requiered Docker containers

Other commands

  • yarn test - launches the test runner in the interactive watch mode
  • yarn lint - checks every source code file using ESLint and rules described in .eslintrc
  • yarn format - formats entire project using Prettier according to formatting rules described in .prettierrc
  • docker-compose down - stops all Docker containers

Technologies used#

The program was created using the following technologies:

Flow#

TeamUp Database schema API actions

Resources#